/*
 * This library is part of OpenCms -
 * the Open Source Content Management System
 *
 * Copyright (c) Alkacon Software GmbH & Co. KG (http://www.alkacon.com)
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * For further information about Alkacon Software, please see the
 * company website: http://www.alkacon.com
 *
 * For further information about OpenCms, please see the
 * project website: http://www.opencms.org
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */

package org.opencms.rmi;

import java.rmi.Remote;
import java.rmi.RemoteException;
import java.util.List;

/**
 * Remote interface for executing shell commands.<p>
 */
public interface I_CmsRemoteShell extends Remote {

    /**
     * Signals to the remote object that the client is done with it (i.e. it can be disposed).<p>
     *
     * @throws RemoteException if something goes wrong
     */
    void end() throws RemoteException;

    /**
     * Executes a shell command .<p>
     * @param cmd the command
     * @param params the parameters
     *
     * @return the shell command result
     *
     * @throws RemoteException if RMI stuff goes wrong
     */
    CmsShellCommandResult executeCommand(String cmd, List<String> params) throws RemoteException;

    /**
     * Returns the initial prompt to use.<p>
     *
     * @return the prompt
     *
     * @throws RemoteException if RMI stuff goes wrong
     */
    String getPrompt() throws RemoteException;

}
